home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / comm / ums / SetFolder1_2.lha / UMS / Doc / English / SetFolder.doc < prev    next >
Encoding:
Text File  |  1995-04-15  |  11.2 KB  |  373 lines
  1. SetFolder 1.2 - Documentation
  2. *****************************
  3.  
  4. Copyright
  5. *********
  6.  
  7.    SetFolder (C) 1994-95 kMel, Klaus Melchior
  8.  
  9.    This program is freely distributable, but copyrighted by me. This
  10. means you may freely copy it as long as you do not charge more than a
  11. nominal fee for copying. This program may be put on PD disks,
  12. especially on Fred Fish's AmigaLibDisks and Fred's CDROMs. If you want
  13. to distribute this program you MUST keep this document with it. The
  14. program and the documents must be distributed in their original
  15. unmodified form.
  16.  
  17.    This program cannot be used for commercial purposes without written
  18. permission by the author.  The author can not be made responsible for
  19. any damage which is caused by using this program.
  20.  
  21.    Send comments, suggestions or bug reports, and the gifts to:
  22.  
  23.      Klaus Melchior, Schulstrasse 17
  24.      D-52156 Monschau, Germany
  25.      Phone: +49 (0)2472 4710
  26.      
  27.      DE:   kmel@eifel.tng.oche.de
  28.      ADSP: kmel@eifel.adsp.sub.org
  29.      FIDO: 2:242/158.2@fidonet
  30.      DE:   kmel@cwg.fido.de
  31.  
  32. What is SetFolder ?
  33. *******************
  34.  
  35.    SetFolder is an UMS tool, which scans the message base for
  36. non-foldered mails, checks their contents and if necessary set them to
  37. a folder.
  38.  
  39.    * fast algorithm is used to check the conditions, indexed fields are
  40.      known
  41.  
  42.    * large UMS fields can be cut (check text of huge mails is slow)
  43.  
  44.    * setable age of mails, which should be foldered
  45.  
  46.    * mails of mailinglists are recognized and automatically set
  47.  
  48.    * ReplyName & ReplyAddr can be adjusted
  49.  
  50.    * the folder of the parent mail can be set
  51.  
  52.    * a report can be sent
  53.  
  54.    * config is stored in 'ums.config'
  55.  
  56.    Background: I subscribed over 10 mailinglists and sort them to
  57. folders with 'sumsfolder', but this takes a lot of time. Many of them
  58. are recognized using a pattern, so every new mail must be read, the text
  59. or comments must be checked. This procedure is started again and again
  60. for each mailinglist :-C
  61.  
  62.    So I decided to write SetFolder.
  63.  
  64.    After SetFolder is started, it knows all UMS fields with an index,
  65. the mails with this fields are checked quickly. Then it checks the other
  66. mails by reading mail after mail, but only one time. To do this fast,
  67. it isn't going from folder to folder.
  68.  
  69.    It is possible to look for mailinglist mails. When the FromName or
  70. ReplyName of mails matches the pattern "mailinglist '#?'", which is
  71. used by several mailinglists, the mailinglist name is stripped and used
  72. as folder name (see Arguments). It works like "mlist2folder.rexx".
  73.  
  74.    The mailinglist mails can be checked before the indexed scan begins.
  75. If no folder of a message is found, the parent one can be read to copy
  76. it's folder name, like "Child2Folder" (see Arguments).
  77.  
  78.    Several mailinglists don't set the right or no reply name and
  79. address.  SetFolder can repair this. When setting the folder, you can
  80. define ReplyName and ReplyAddr.
  81.  
  82. CLI arguments
  83. *************
  84.  
  85.    TEMPLATE:
  86.          NAME=USER/A,PASSWORD/A,SERVER/K,
  87.          AGE/K/N,CHECKLEN/K/N,MLIST/S,MLISTFIRST/S,PARENT/S,NOTOWNER/S,
  88.          TEST/S,NOINDEXED/S,DELAY/K/N,NOPROGRESS/S,QUIET/S
  89.  
  90. AGE/K/N
  91.      mails which age is younger than the defined number of days are
  92.      checked, default: 0 days, only the new ones
  93.  
  94. DELAY/K/N
  95.      use SetFolder as background task, all actions are delayed, low task
  96.      priority, set here the time for Delay() in 1/50 sec
  97.  
  98. MLIST/S
  99.      mailinglist mails are recognized
  100.  
  101. MLISTFIRST/S
  102.      check mailinglist mails at first
  103.  
  104. NOINDEXED/S
  105.      the indexed look for folders isn't started
  106.  
  107. NOPROGRESS/S
  108.      the progress indicator isn't shown
  109.  
  110. NOTOWNER/S
  111.      only mails are checked, which UMS owner flag isn't set
  112.  
  113. PARENT/S
  114.      if no folder is found, the parent mail is checked
  115.  
  116. PASSWORD/A
  117.      password of the user
  118.  
  119. QUIET/S
  120.      no output text
  121.  
  122. SERVER/K
  123.      name of the server, optional
  124.  
  125. TEST/S
  126.      switches SetFolder into test mode, no folders are set
  127.  
  128. CHECKLEN/K/N
  129.      the UMS fields are cut, set here the number of bytes, which are
  130.      checked with MatchPattern(), sometimes useful with MsgText or
  131.      Comments
  132.  
  133. USER=NAME/A
  134.      user name
  135.  
  136. UMS Fields
  137. **********
  138.  
  139.    These names of UMS fields are checked by SetFolder:
  140.  
  141.      MsgText
  142.      FromName
  143.      FromAddr
  144.      ToName
  145.      ToAddr
  146.      MsgID
  147.      Subject
  148.      Comments
  149.      Organization
  150.      ReplyName
  151.      ReplyAddr
  152.      LogicalToName (UMSV11)
  153.      LogicalToAddr (UMSV11)
  154.  
  155.    Check your config! SetFolder gives you a warning if an UMS field
  156. isn't recognized (see Installation).
  157.  
  158. What you need !
  159. ***************
  160.  
  161.    - Kickstart >= 2.0
  162.  
  163.    - Workbench >= 2.0
  164.  
  165.    - UMS (Universal Message System) >= v10 (see: References)
  166.  
  167.    - Several additions in 'ums.config' (see: Installation)
  168.  
  169. How to install
  170. **************
  171.  
  172. Binaries
  173. ========
  174.  
  175.    Copy the "bin/" files to a place where all the executables of UMS are
  176. stored, normally this is "UMS:bin/" or "Mail:bin/".
  177.  
  178.      copy bin/#? Mail:bin/
  179.  
  180. UMS config
  181. ==========
  182.  
  183.    These UMS config variables must be set global:
  184.  
  185. SetFolder.ReportUser (optional)
  186.      Specify the user to whom the report is sent. Only if this variable
  187.      is set a report is generated.
  188.  
  189. SetFolder.ReportFolder (optional)
  190.      The report mail is put into the defined folder.
  191.  
  192. setfolder.Folder
  193.      It could contain several lines with the folder name, the UMS field,
  194.      which is checked (see: UMS Fields), the data and an optional
  195.      reply. One condition per line, four arguments seperated with at
  196.      least one space.
  197.  
  198.           <FolderName> <UMS Field> <Text/Pattern> [<ReplyName>,<ReplyAddr>]
  199.  
  200.      A ; in front of the FolderName marks the line as comment.
  201.  
  202. Example
  203. =======
  204.  
  205.      UMS v10 ------------------------------------------
  206.      setfolder.ReportUser = "sysop"
  207.      setfolder.ReportFolder = "report"
  208.      setfolder.Folder = "
  209.          mui                Comments   *"#?(To|Cc):#?mui@taloa.unice.fr#?*" *"mui,mui@taloa.unice.fr*"
  210.          aminet             FromAddr   *"aminetd@wuarchive.wustl.edu*"
  211.          meeting            ReplyName  *"Mailinglist 'Meeting'*"
  212.          ; comment
  213.          music.paperlate    MsgText    *"#?(To|Cc):#?paperlate@atom#?*"
  214.          trash              Subject    *"Point-Beitrag*"
  215.      "
  216.      --------------------------------------------------
  217.      
  218.      UMS v11 ------------------------------------------
  219.      ( SetFolder.ReportUser syops )
  220.      ( SetFolder.ReportFolder report )
  221.      ( SetFolder.Folder
  222.          "mui                Comments   \"#?(To|Cc):#?mui@taloa.unice.fr#?\" \"mui,mui@taloa.unice.fr\"\n"
  223.          "aminet             FromAddr   \"aminetd@wuarchive.wustl.edu\"\n"
  224.          "meeting            ReplyName  \"Mailinglist 'Meeting'\"\n"
  225.          "; comment\n"
  226.          "music.paperlate    MsgText    \"#?(To|Cc):#?paperlate@atom#?\"\n"
  227.          "trash              Subject    \"Point-Beitrag\"\n"
  228.        )
  229.      --------------------------------------------------
  230.  
  231. Startup
  232. =======
  233.  
  234.    I start SetFolder like this:
  235.  
  236.      SetFolder sysop "" Delay 5 CheckLen 2000 Parent
  237.  
  238. History of SetFolder
  239. ********************
  240.  
  241.  
  242.            27.08.94  * initial
  243.                      * first working version
  244.                      + busy ascii routines
  245.      
  246.            28.08.94  + documentation
  247.       0.1            * beta to [ah] [mh]
  248.      
  249.            30.08.94  + documentation changed
  250.       0.2            * beta to [cr] [fd] [op]
  251.      
  252.            05.09.94  + NOPROGRESS/S implemented, progress indicator can be
  253.                        switched off [op]
  254.                      + AGE/K/N implemented, old mails can be checked [op]
  255.                      + documentation changed
  256.      
  257.       0.3  07.09.94  * beta to [cv] [op]
  258.      
  259.            06.10.94  * first feedback :-C
  260.      
  261.            08.10.94  + CHECKLEN/K/N implemented
  262.      
  263.            11.10.94  + NOTOWNER/S added [ah]
  264.      
  265.       1.0  12.10.94  * release to aminet
  266.      
  267.            10.11.94  + mailinglist recognition, MLIST/S added [ms]
  268.        b1            * beta to [ms]
  269.      
  270.            12.11.94  - fixed bug in mailinglist name routine [ms]
  271.                      + CTRL-C works now
  272.        b2            * beta to [ms]
  273.      
  274.            19.11.94  - fixed bug in folder routine
  275.      
  276.            21.11.94  + insert ReplyName, ReplyAddr (option) [ss]
  277.        b3            * beta to [ss] [ah]
  278.      
  279.            23.11.94  - fixed bug after reading corrupt message [ms]
  280.        b4            * beta to [ms]
  281.      
  282.            06.12.94  - fixed bug in mlist routine [ms]
  283.        b5            * beta to [ms]
  284.      
  285.       1.1  13.12.94  * release to aminet
  286.      
  287.            09.03.95  + MList handling changed [hg]
  288.        b1            * beta to [hg]
  289.      
  290.            24.03.95  + MLISTFIRST/S implemented [hg] [bf]
  291.                      - MList output bug fixed [hg]
  292.        b2            * beta to [hg] [bf]
  293.      
  294.            25.03.95  - change CLI template [op]
  295.                      + ability to write a report
  296.                      + change archive structure
  297.      
  298.        b3  27.03.95  * beta to wowbagger
  299.      
  300.            01.04.95  + change archive structure, now with "UMS/"
  301.                      - MListFirst/MList fixed [hg]
  302.      
  303.            08.04.95  - output bug of MListFirst fixed
  304.                      + PARENT/S implemented (idea from Child2Folder [op])
  305.                      + NOINDEXED/S added
  306.      
  307.        b4  09.04.95  * beta to Mailinglist
  308.      
  309.            12.04.95  + use own linklib, this reduced size about 2 KByte
  310.      
  311.            14.04.95  - check parent only if no folder is found
  312.                      + additions/changes to documentation
  313.       1.2            * release to aminet
  314.  
  315. What is to do in future ?
  316. *************************
  317.  
  318.    - nothing... ?
  319.  
  320. References
  321. **********
  322.  
  323. UMS
  324.      UMS - Universal Message System (c) Copyright 1992-95 by Martin
  325.      Horneffer
  326.  
  327.      Aminet: comm/ums/      *Note* v11 is only available as public beta
  328.  
  329. Thanks are going to ...
  330. ***********************
  331.  
  332.    - Martin Horneffer [mh] for UMS
  333.  
  334.    - Andreas Harrenberg [ah], Christian Rütgers [cr], Olaf Peters [op],
  335.      Frank Duerring [fd], Christoph Viethen [cv], Matthias Scheler [ms],
  336.      Stefan Stuntz [ss], hartmut Goebel [hg], Boris Folgmann [bf],
  337.      André Schenk [as]
  338.  
  339.    - and all I forgot to mention ...
  340.  
  341. Index
  342. *****
  343.  
  344.  
  345.  
  346.  Arguments                              Arguments
  347.  Authors address                        Copyright
  348.  Background                             Description
  349.  Binaries                               Installation
  350.  Bug reports                            Copyright
  351.  Changes in 'ums.config'                Installation
  352.  CLI arguments                          Arguments
  353.  Comments                               Copyright
  354.  Copyright                              Copyright
  355.  Credits                                Credits
  356.  Description                            Description
  357.  Distribution                           Copyright
  358.  eMail                                  Copyright
  359.  Example                                Installation
  360.  History                                History
  361.  Installation                           Installation
  362.  References                             References
  363.  Requirements                           Requirements
  364.  SetFolder                              Description
  365.  Startup                                Installation
  366.  Template                               Arguments
  367.  Thanks                                 Credits
  368.  ToDo                                   ToDo
  369.  UMS config                             Installation
  370.  UMS fields                             UMS Fields
  371.  UMS variables                          Installation
  372.  
  373.